/*
 * Copyright (c) 2009 Frederic Daoud
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package org.stripesbook.rayures.service;

import java.io.Writer;
import java.util.Map;

/**
 * Interface that defines a template engine, capable of merging a template file and a data model to
 * produce an output to a writer.
 *
 * @author Frederic Daoud
 */
public interface TemplateEngine {
  /** Returns the default extension for template files. */
  String getTemplateFileExtension();

  /** Determines if a template file name is valid, that is, if a suitable template file was found. */
  boolean isTemplateFileNameValid(String fileName);

  /** Merges the template and the data model and produces an output to the writer. */
  void write(String templateFileName, Map<String, Object> dataModel, Writer writer) throws Exception;
}
